home *** CD-ROM | disk | FTP | other *** search
/ Octamed 6 / Octamed 6.iso / text / hello next >
Encoding:
Text File  |  1995-10-16  |  9.4 KB  |  305 lines
  1.                     Hello from Ray at RBF Software
  2.  
  3.    Publisher and Copyright owner of the fantastic music tool OctaMED
  4.  
  5.    Meny is released as freeware but copyright to the prog retained.
  6.  
  7.    You are VERY welcome to use menu in your magazines etc, and you
  8.    are encouraged to do so, but please give recognition to the Author,
  9.    Teijo Kinnunen.
  10.  
  11.    If you are a PD supplier and would like to include this disk in your
  12.    range, or a BBS Sysop and would like to include this program on your
  13.    Bulletin Board, then please write to Ray for written permission
  14.    as allthough Meny is released as Freeware it still remains a Copyright
  15.    program and may not be re-distributed for money, nor placed onto a
  16.    BBS without prior consent being obtained. thank you.
  17.  
  18.    Address your request to:
  19.  
  20.    RBF Software. ( Meny )
  21.    169, Dale Valley Rd, Hollybrook,
  22.    Southampton. SO16 6QX
  23.    England
  24.  
  25. ---------------------------------------------------------------------
  26.  
  27.     Menÿ V1.0  ( For ease of keyboard use, renamed as Meny )
  28.  
  29.     Copyright © 1994 Teijo Kinnunen
  30.     release date: 30.06.1994
  31.     using SAS/C
  32. ---------------------------------------------------------------------
  33.  
  34. Description:
  35. ~~~~~~~~~~~~
  36. Menÿ  is  a  simple  and  short  menu utility for disk-magazines etc.
  37. Earlier  versions  of  this  program  have already been use (e.g.  in
  38. AM/FM),  and it has been found to be reliable.  Because I got several
  39. requests to release this program separately, I've done so.  I renamed
  40. it  'Menÿ', to separate it from earlier versions, and to finally make
  41. some  use of the 'ÿ' character that doesn't exist in any language :-)
  42. (Tip:  type Alt-k and y to see it, but for ease of use, it's Meny )
  43.  
  44. Features:
  45. ~~~~~~~~~
  46. * Fully multitasking and OS-compliant
  47. * Works under any OS version since 1.2
  48. * Short (only about 11 kilobytes)
  49. * Reliable (I hope :-)
  50. * Easy-to-use script language
  51. * Can display a logo picture above the actual menus
  52. * Flexible handling of sub-menus
  53. * Can bring Workbench to front if desired
  54.  
  55. Basic operation:
  56. ~~~~~~~~~~~~~~~~
  57. The  purpose  of this program is simply to launch executable programs
  58. by  pressing  buttons.   These buttons are arranged as 'menus', which
  59. are  laid  out by this program (note:  these menus are different from
  60. Intuition  menus, they are actually arrays of gadgets).  You can also
  61. create buttons that bring up new menus (sub-menus).
  62.  
  63. Suppose  you  want  to create a disk-magazine.  There's always a main
  64. menu, which is displayed first.  Here's an example of such menu:
  65.  
  66. TITLE Meny OctaMED Users Group ( MUG )
  67. WITEM Editorial
  68. more editorial.txt
  69. WITEM News
  70. more news.txt
  71. ENDM
  72.  
  73. It's  very  simple  one, containing only two buttons.  The first line
  74. contains  a  command  TITLE,  which displays the following text.  The
  75. second  line  says  WITEM (Wide ITEM); it creates a button with label
  76. 'Editorial'.  The following line is the command that will be executed
  77. when   the   button   is   pressed,  it  will  display  a  text  file
  78. 'editorial.txt'.   Another button 'News' does exactly the same thing.
  79. Finally,  there's  an  ENDM  command  (END Menu).  Every menu must be
  80. terminated with this command.
  81.  
  82. Here's a more complex example:
  83.  
  84. TITLE Meny Journal
  85. WITEM Editorial
  86. more editorial.txt
  87. WITEM News
  88. more news.txt
  89. TITLE
  90. WMENU Mail from the users
  91. UsersMail
  92. ENDM
  93.  
  94. SUBM UsersMail
  95. ITEM Suggestions
  96. more suggestions.txt
  97. ITEM V1.0 Bug reports
  98. more bugreports.txt
  99. SECCOL
  100. ITEM Menÿ User's Diary by X.X.
  101. ENDM
  102.  
  103. Differences from the previous example:
  104. TITLE with no text produces an empty line
  105. WMENU produces a sub-menu button instead of an action button.
  106.       The following line contains the name of the sub-menu.
  107. SUBM specifies the beginning of a sub-menu.
  108. ITEM produces a normal item (half of the width of the screen).
  109. SECCOL starts a second column of half-width items
  110.  
  111. Look  at  the  file  'example_menu'  for  an  example  of most of the
  112. features.
  113.  
  114. Usage
  115. ~~~~~
  116. Currently,  Menÿ  can  be  started from CLI/Shell only.  (A Workbench
  117. interface can be created with IconX.) The command line is simply:
  118.  
  119.     meny <script>
  120.  
  121. Where  <script>  is  the menu description file.  The description file
  122. can be no longer than 1000 lines long.
  123.  
  124. Using logo pictures
  125. ~~~~~~~~~~~~~~~~~~~
  126. If  you  specify  a  logo picture, it will be displayed on the top of
  127. every menu page, all menu buttons below it.  This logo is global, and
  128. can not be changed or removed.
  129.  
  130. Because  Menÿ  should  be  as  short  as  possible,  and because logo
  131. pictures  are  not  changed  often,  there's  no IFF-loader built in.
  132. Instead,  Menÿ  loads  the  picture in raw format.  I've provided the
  133. public  domain  ILBMtoRaw  program (by Electronic Arts) just for this
  134. purpose.
  135.  
  136. You  should  create an IFF-brush using a paint program, it should use
  137. the standard WB palette (Menÿ always uses the Workbench palette).  It
  138. shouldn't  be  wider  than 640 pixels, and generally no more than two
  139. planes deep (four colors).  Save the brush.
  140.  
  141. Now  enter  ILBMtoRaw brushname.  You get a raw data file called e.g.
  142. brushname.hi.612x36x2.  This is the data file you should provide with
  143. the menu, you can rename it if you desire.
  144.  
  145. The  first four lines of the script must define the parameters of the
  146. picture.   They  *must* always be the very first four lines, and they
  147. must appear exactly in the following order:
  148.  
  149. PICTURE brushname.hi.612x36x2
  150. PICWIDTH 612
  151. PICHEIGHT 34
  152. PICDEPTH 2
  153.  
  154. You  get the dimensions from the name ILBMtoRaw produces.  If any one
  155. of the above lines is missing or invalid, you get no picture.
  156.  
  157. Commands
  158. ~~~~~~~~
  159. Here's  a summary of all commands that can be used in the menu script
  160. file.  The command names are not case-sensitive.
  161.  
  162. TITLE text
  163.  
  164.     Displays a line of text (3-D, centered). Displays an empty
  165.     line if 'text' not specified.
  166.  
  167. ITEM label
  168. cmd1
  169. cmd2
  170. ...
  171. WITEM label
  172. cmd1
  173. cmd2
  174. ...
  175.  
  176.     Creates an action button. When the button is pressed, the
  177.     specified commands (cmd1, cmd2,...) are executed. You can
  178.     specify as many commands as you wish. There are two special
  179.     commands: 'WBToFront' and 'MenuToFront' which cause the
  180.     screens to be organized. Helpful if you want to execute a
  181.     program that opens its window on the WB screen, you can
  182.     write:
  183.  
  184.         ITEM executeprog
  185.         WBToFront
  186.         programname
  187.         MenuToFront
  188.  
  189.     The commands are executed synchronously. You cannot continue
  190.     using the menus until the last command has returned.
  191.  
  192.     WITEM creates a wide (full-width) button, ITEM creates a
  193.     half-width button.
  194.  
  195. MENU label
  196. menuname
  197. WMENU label
  198. menuname
  199.  
  200.     Creates a sub-menu button. When pressed, it will bring up
  201.     a sub-menu 'menuname' (see command SUBM). A white '»'-symbol
  202.     marks a sub-menu button.
  203.  
  204.     WMENU creates a wide (full-width) button, MENU creates a
  205.     half-width button.
  206.  
  207. HDR text
  208.  
  209.     Displays a text string on the current (left or right) column.
  210.     Can be used to produce headers for two-column button arrays.
  211.  
  212. SECCOL
  213.  
  214.     Starts a new column of half-width buttons. The following
  215.     button, if half-width, will appear below the last full-width
  216.     item on the right column.
  217.  
  218. ENDM
  219.  
  220.     Ends a menu. Every menu and sub-menu must be terminated with
  221.     this command.
  222.  
  223. SUBM menuname
  224.  
  225.     Marks the beginning of a new sub-menu.
  226.  
  227. ITEMQ label
  228. WITEMQ label
  229.  
  230.     As ITEM and WITEM, but will cause the Menÿ program to exit.
  231.     They may not be very useful, as there's a Quit-button always
  232.     displayed on the screen.
  233.  
  234. ISSUE text
  235.  
  236.     Can be used to print a short text (e.g. the number of issue)
  237.     above the logo picture. You should provide enough space in
  238.     the picture for the text. If you don't use logo picture, you
  239.     shouldn't use this command (it only overwrites gadgets).
  240.  
  241.     This command can be used only once. Generally it should
  242.     appear on the main menu.
  243.  
  244. PICTURE filename
  245. PICWIDTH width
  246. PICHEIGHT height
  247. PICDEPTH depth
  248.  
  249.     See 'Using logo pictures' above..
  250.  
  251.  
  252. Notes
  253. ~~~~~
  254. Menÿ  uses a 640×STDSCREENHEIGHT-sized screen, but doesn't allow more
  255. than  200 pixels for display.  This forces even unconcerned PAL-users
  256. to  create  NTSC-compatible  menus.  The screen will be public (name:
  257. Meny_Screen), and will not close until all visitors have closed their
  258. windows.
  259.  
  260.  
  261. Remember, the meny exec is in the c dir, the example_menu is in the
  262.           s dir and the raw picy is ( guess ), text is .......
  263.  
  264. Distribution
  265. ~~~~~~~~~~~~
  266. Menÿ is copyright (c) 1994 Teijo Kinnunen. All rights reserved.
  267. This program and accompanied files may be freely distributed if
  268. the following conditions are met:
  269.  
  270.  
  271. 1) Free_ distribution is allowed, i.e. if NO money "at all" is involved.
  272.  
  273. 2) The Meny executable may be distributed as an integral
  274.    part of disk magazines, catalogs or wherever it is being used.
  275.    (whether commercial or not) without any fees to the author.
  276.  
  277. 3) Commercial & PD-distributors are not allowed to distribute
  278.    sell the package without permission from the author.
  279.    (Except as stated in condition 2: when the program is
  280.    required to display an actual disk-magazine or similar.)
  281.  
  282.     Fred Fish
  283.  
  284.  
  285. Note: ILBMtoRaw is Public Domain. None of the above conditions
  286.       apply to it. It's distributed here for your convenience only.
  287.       PPSHOW is Public Domain.    None of the above conditions
  288.       apply to it. It's distributed here for your convenience only.
  289.       PPMM is Public Domain.      None of the above conditions
  290.       apply to it. It's distributed here for your convenience only.
  291.  
  292. Author
  293. ~~~~~~
  294.     Teijo Kinnunen
  295.     Oksantie 19
  296.     FIN-86300  OULAINEN
  297.     FINLAND
  298.  
  299. If you wish to contact me, e-mail TEIJOK on the OctaMED BBS
  300.  
  301. History
  302. ~~~~~~~
  303. V1.0    (30.05.1994)
  304.  
  305.     Initial release, based on AMFMMenu which I wrote for our pal Bjørn.